List Custom Fields
AutomatR.DocuSign.Activities.ListCustomFields
The "List Custom Fields" activity in AutomatR is part of the DocuSign Envelope Custom Fields package, providing functionality to retrieve a list of custom fields associated with a specific envelope in DocuSign. This activity facilitates the seamless integration of custom data fields within DocuSign-enveloped workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID to identify the DocuSign envelope for which custom fields need to be retrieved. This field supports only Strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "List Custom Fields" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the custom fields associated with the specified envelope in the form of a CustomFieldsEnvelope object. Variables of data type CustomFieldsEnvelope to store the custom field details. |
How to use:
- Drag and drop the "List Custom Fields" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and optionally, the Delay.
- Execute the workflow to retrieve information about custom fields associated with the specified envelope.
Important Note:
- Ensure that the "List Custom Fields" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "List Custom Fields" activity is used to retrieve custom fields associated with an envelope:
List Custom Fields:
Delay: 5
Envelope ID: "env123"
Response: customFieldsInfo
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about custom fields associated with the envelope having ID "env123." The details of the custom fields are stored in the variable "customFieldsInfo" for further processing in the workflow.